Important: The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).min-value sec: Specifies the minimum amount of time for Retry-After Header. sec must be an integer from 2 to 3600. Default is 2 seconds.
max-value sec: Specifies the maximum amount of time for Retry-After Header. sec must be an integer from 3 to 3601. Default is 10 seconds.
Important: Maximum value should be greater than minimum value.The following command configures the minimum value to 3and maximum value to 12 for Retry-After Header:
access-service name name
name name
name must be from 1 to 63 alpha and/or numeric characters.
Important: This command should only be issued in the core service configuration, however, multiple access services may be configured per core service.The following command identifies the P-CSCF/A-BG access service named to the CSCF/A-BG core service:
access-type { type } access-profile { default | name access_profile_name } | ue-ip-address-range name ue_ip_name { address ip_address_mask | range start_ip_address end_ip_address }
3gpp-e-utran-fdd: 3GPP Access Type
3gpp-e-utran-tdd: 3GPP Access Type
3gpp-geran: 3GPP Access Type
3gpp-utran-fdd: 3GPP Access Type
3gpp-utran-tdd: 3GPP Access type
3gpp2-1x: 3GPP2 Access Type
3gpp2-1x-hrpd: 3GPP2 Access Type
3gpp2-umb: 3GPP2-UMB
adsl: FixedLine Access Type
adsl2: FixedLine Access Type
adsl2p: FixedLine Access Type ADSL2+
docsis: DOCSIS
gshdsl: FixedLine Access Type G.SHDSL
hdsl: FixedLine Access Type
hdsl2: FixedLine Access Type
idsl: FixedLine Access Type
ieee-80211: WLAN Access Type
ieee-80211a: WLAN Access Type
ieee-80211b: WLAN Access Type
ieee-80211g: WLAN Access Type
ieee-80211n: WLAN Access Type
ieee-80216e: Wireless MAN Access Type
ieee-8023: Ethernet Access Type
ieee-8023a: Ethernet Access Type
ieee-8023ab: Ethernet Access Type
ieee-8023ae: Ethernet Access Type
ieee-8023ak: Ethernet Access Type
ieee-8023an: Ethernet Access Type
ieee-8023aq: Ethernet Access Type
ieee-8023e: Ethernet Access Type
ieee-8023i: Ethernet Access Type
ieee-8023j: Ethernet Access Type
ieee-8023u: Ethernet Access Type
ieee-8023y: Ethernet Access Type
ieee-8023z: Ethernet Access Type
radsl: FixedLine Access Type
sdsl: FixedLine Access Type
vdsl: FixedLine Access Type
ue-ip-address-range name ue_ip_name { address ip_address_mask | range start_ip_address end_ip_address }
ue_ip_name must be from 1 to 79 alpha and/or numeric characters.
address ip_address_mask: Specifies a combined IP address subnet mask bits to indicate what IP addresses the specific access-type applies to. ip_address_mask must be specified using the form “IP Address/Mask Bits” where the IP address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6, and the mask bits are a numeric value, which is the number of bits in the subnet mask.
range start_ip_address end_ip_address: Configure UE IP range for specific access-type.
|
•
|
start_ip_address specifies the beginning of the range of addresses.
|
|
•
|
end_ip_address specifies the end of the range of addresses.
|
|
•
|
ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
|
Important: Use the sip-header command to enable SIP P-Access-Network-Info (PANI) header insertion. CSCF Proxy-CSCF Configuration Mode commands are defined in the CSCF Proxy-CSCF Configuration Mode Commands chapter in this guide.bind address ip_address [ cscf-hostname host_name ] [ ipsec-crypto-template template ] [ max-sessions max# ] [ port number ] [ reserved-call-capacity percentage ] [ tls-crypto-template template [ tls-port number ] ] [ transport tcp ] [ use-serviceport-towards-network ]
address ip_address
ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
cscf-hostname host_name
host_name must be an existing CSCF service name and be from 1 to 127 alpha and/or numeric characters.
Configuring this keyword associates the CSCF service with the AOR domain configured in the default-aor-domain command and uses the domain name in SIP headers.
Important: If this keyword is not configured, SIP headers will contain the IP address of the CSCF service instead of the domain name.ipsec-crypto-template template
template must be an existing IPSec CSCF crypto template and be from 1 to 127 alpha and/or numeric characters.
Important: The IPSec CSCF crypto template should be configured in the same context in which the P-CSCF is configured.max-sessions max#
max# must be configured to any integer value from 0 to 500,000.
Important: The total session capacity of the system is 500,000. max-sessions is also limited by the capacity in the license generated for the service. If licenses for PDSN/GGSN/HA are generated for x number of sessions, then the license for the CSCF service will be generated at 500,000-x. Hardware configuration and installed features can also affect the maximum number of sessions that can be supported.port number
number must be an integer value from 1 to 65534.
reserved-call-capacity percentage
percentage must be an integer value from 1 to 50.
template must be an existing TLS crypto template and be from 1 to 127 alpha and/or numeric characters.
number must be an integer value from 1 to 65534.
Important: When the tls-crypto-template is configured, TCP transport must be enabled, otherwise this command will throw an error. The configured tls-crypto-template should be should be configured in the same context in which the P-CSCF service is configured and must be complete with all certificate and cipher suite configuration. If the tls-crypto-template is not present or not completely configured, the P-CSCF service will not be started.
Important: Multiple keywords can be used per bind command.The following command binds the CSCF service to a logical interface with an IP address of 1.2.3.4 and sets the maximum number of supported sessions for this interface at 250000:
CSCF Charging Configuration Mode commands are defined in the CSCF Charging Configuration Mode Commands chapter in this guide.
[ no ] cnsa-media-profile profile_id cscf-service-policy policy_name content-type { application-3gpp-ims-xml | application-pidf-diff-xml | application-pidf-partial-xml | application-pidf-xml | application-reginfo-xml | application-sdp | application-xml | message-sipfrag | multipart-mixed | multipart-related | text-plain }
cnsa-media-profile profile_id
profile_id must be an integer from 0 to 10 and be an existing media profile id in the system. CNSA media profile ids are created and maintained in the CSCF ISC Template Configuration Mode.
cscf-service-policy policy_name
policy_name must be from 1 to 63 alpha and/or numeric characters and be an existing policy name in the system. Service policies are created and maintained in the CSCF Policy Configuration Mode.
application-3gpp-ims-xml - format for exchanging information in SIP Requests and Responses as used within the 3GPP IM CN Subsystem
application-pidf-diff-xml - contains changed presence elements. Contains full presence document when there are many changes
application-pidf-partial-xml - contains only changed parts of PIDF-based presence information
application-pidf-xml - XML MIME entity that contains presence information
application-reginfo-xml - used in Notifications to SIP user agents about registration expiry
application-sdp - SDP session description
application-xml - content type for generic xml documents
message-sipfrag - contains subsets of well formed SIP messages
multipart-mixed - intended for use when the body parts are independent and need to be bundled in a particular order
multipart-related - intended for compound objects consisting of several inter-related body parts
text-plain - plain text
Important: You may specify multiple types of content.The following command defines the media profile id as 2 and assigns it to serv_policy3 with plain text content type.
[ no ] core-service name service_name
name service_name
service_name must be from 1 to 80 alpha and/or numeric characters.
custom response { ue-capability-failure capability_type | ue-status status } reject response-code response_code
ue-capability-failure capability_type
|
•
|
all - UE capability all
|
|
•
|
at - UE capability AT
|
|
•
|
audio - UE capability audio
|
|
•
|
chat - UE capability CHAT
|
|
•
|
cs - UE capability CS
|
|
•
|
ft - UE capability FT
|
|
•
|
im - UE capability IM
|
|
•
|
mms - UE capability MMS
|
|
•
|
msg - UE capability MSG
|
|
•
|
oma-sip-im - UE capability OMA SIP-IM
|
|
•
|
rcs-dp - UE capability RCS-e DP
|
|
•
|
rcs-e - UE capability RCS-E
|
|
•
|
rcs-ft - UE capability RCS-e FT
|
|
•
|
rcs-im - UE capability RCS-e IM
|
|
•
|
rcs-is - UE capability RCS-e IS
|
|
•
|
rcs-sp - UE capability RCS-e SP
|
|
•
|
rcs-vs - UE capability RCS-e VS
|
|
•
|
text - UE capability text
|
|
•
|
video - UE capability video
|
|
•
|
vt - UE capability VT
|
|
•
|
vt-ft - UE capability VT-FT
|
|
•
|
vt-is - UE capability VT-IS
|
|
•
|
vt-loc - UE capability VT-LOC
|
|
•
|
vt-memo - UE capability VT-MEMO
|
ue-status status
|
•
|
1x-busy - UE status 1x-busy
|
|
•
|
all - UE status all
|
|
•
|
idle - UE status idle
|
|
•
|
power-off - UE status power-off
|
|
•
|
unreg - UE status unreg
|
|
•
|
vt-busy - UE status vt-busy
|
reject response-code response_code
response_code must be an integer from 400 to 699.
The following command configures S-CSCF reject with response code 455 for a UE capability audio failure.
alias is the name of the domain for this service and must be from 1 to 79 alpha and/or numeric characters in length.
Emergency-CSCF Configuration Mode commands are defined in the CSCF Emergency-CSCF Configuration Mode Commands chapter in this guide.
Important: Only one function (P-CSCF, S-CSCF, E-CSCF, SIP Proxy, or A-BG) can be enabled per service. keepalive [ expire-timer sec [ max-retry num ] | max-retry num [ expire-timer sec ] | method { crlf | stun } [ expire-timer sec [ max-retry num ] | max-retry num [ expire-timer sec ] ] ]
expire-timer sec
sec must be an integer from 24 to 150.
max-retry num
num must be an integer from 1 to 10.
crlf: “\r\n” string (CRLF packets) sent by UE
stun: STUN protocol messages (rfc3489-bis)
Refer to the Lawful Intercept Configuration Guide for more information on LI.
Refer to the Lawful Intercept Configuration Guide for a description of this command.
max-sipmsg-size limit
limit must be an integer from 1024 to 65535.
Important: Maximum SIP message size should be more than the message-max-size set in the CSCF Proxy-CSCF Configuration Mode.v6port-range start_port end_port
start_port: Start of port range; must be an integer from 1024 to 65535.
end_port: End of port range; must be an integer from 1025 to 65535.
nat-policy policy_name { private-address { address ip_address_mask | default | range start_ip_address end_ip_address } | bridge-network { address ip_address_mask | range start_ip_address end_ip_address }
no nat-policy policy_name
policy_name must be from 1 to 79 alpha and/or numeric characters.
address ip_address_mask: Address for nat-policy policy type for nat-pool. Specifies a combined IP address subnet mask bits to indicate what IP addresses the specific policy type applies to. ip_address_mask must be specified using the form “IP Address/Mask Bits” where the IP address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6, and the mask bits are a numeric value, which is the number of bits in the subnet mask.
default: Default for nat-policy policy type for nat-pool. Default is defined as the address range specified by rfc1918.
range start_ip_address end_ip_address: Range for nat-policy policy type for nat-pool.
|
•
|
start_ip_address specifies the beginning of the range of addresses.
|
|
•
|
end_ip_address specifies the end of the range of addresses .
|
|
•
|
ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
|
address ip_address_mask: Address for bridge-network policy type for S-CSCF bridging. Specifies a combined IP address subnet mask bits to indicate what IP addresses the specific policy type applies to. ip_address_mask must be specified using the form “IP Address/Mask Bits” here the IP address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6, and the mask bits are a numeric value, which is the number of bits in the subnet mask.
range start_ip_address end_ip_address: Range for bridge-network policy type for S-CSCF bridging.
|
•
|
start_ip_address specifies the beginning of the range of addresses.
|
|
•
|
end_ip_address specifies the end of the range of addresses.
|
|
•
|
ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
|
The following command identifies the NAT policy named policy1 with a private-address policy type of 10.10.10.10 255.255.255.0:
The following command identifies the NAT policy named policy2 with a private-address range policy type of 172.162.23.23 172.162.23.230:
The following command identifies the NAT policy named policy3 with a default policy type:
no nat-pool name pool_name
name pool_name
pool_name must be from 1 to 32 alpha and/or numeric characters.
Important: NAT pools are created in Context Configuration Mode with the ip pool command.signalling-pool signalling_pool_name
signalling_pool_name must be from 1 to 32 alpha and/or numeric characters.
Important: If signalling-pool is not specified, service IP:port will be filled in signalling headers.policy { accounting interim-interval value | allow-early-media | ibcf-capability domain domain/name | overload [ drop | redirect IPv4_address1 [ weight weight1 ] [ IPv4_address2 [ weight weight2 ] ] ... | reject ] | threshold congestion-control { system-cpu-utilization percent | tolerance percent } }
no policy { accounting interim-interval | allow-early-media | ibcf-capability domain domain/name | overload [ redirect IPv4_address1 ] [ IPv4_address2 ] ... | threshold congestion-control { system-cpu-utilization | tolerance } }
value can be configured to any integer value from 50 to 7200. This value is sent in the “Acct-Interim-Interval” AVP of the accounting message. Based on the response message from accounting server, Interim-Interval timer is started.
ibcf-capability domain domain/name
Important: This CLI can be repeated to add/delete multiple entities to/from the ibcf-capability domain table. An ibcf-capability domain can be removed by using the no keyword; using the no keyword without giving any domain name will delete all entries from the list.overload [ drop | redirect IPv4_address1 [ weight weight1 ] [ IPv4_address2 [ weight weight2 ] ] ... | reject ]
drop: Specifies that upon policy overload, the system will drop the session.
redirect: Specifies that upon policy overload, the system will redirect the session to another CSCF.
|
•
|
IPv4_address1 must be expressed in dotted decimal notation.
|
|
•
|
weight weight1: Defines the priority of the redirect address.
|
weight1 must be an integer from 1 to 10. Default is 1.
reject: Specifies that upon policy overload, the system will reject the session with 503 (Service Unavailable) SIP error response. This is the default setting.
|
•
|
Level 1: For every new call/event received, the system checks if sessmgr memory-usage is above a threshold value (such as 95 percent). If it is, memory-congestion is triggered and new call messages are rejected with 500 SIP response. Memory congestion is disabled when memory usage drops by a tolerance value (default is 10 percent).
|
|
•
|
Level 2: If the sessmgr usage reaches 100 percent, all newly received SIP messages are dropped at the socket layer in that sessmgr except for the BYE message. The new SIP messages are not processed until the memory reaches the threshold value (95 percent).
|
system-cpu-utilization percent: The average percent utilization of a CPU in a PSC/PSC2/PSC3 running the CSCF service as measured in 10 second intervals.
percent can be configured to any integer value from 0 to 100. This value becomes the upper threshold for triggering the CPU-based congestion for CSCF services. Default is 80
tolerance percent: The percentage under a configured threshold that dictates the point at which the condition is cleared.
percent is an integer value from 1 to 25. Default is 5
|
•
|
Set QoS support during either the initial SDP response or the 200OK response to the INVITE. When allow-early-media is enabled, QoS commit is done during initial SDP answer. When disabled, QoS commit is done during 200OK INVITE. By default, this command is enabled.
|
Important: When congestion is triggered, new CSCF calls are not rejected.policy-name name
name must be from 1 to 79 alpha and/or numeric characters and be an existing policy name in the system. Service policies are created and maintained in the CSCF Policy Configuration Mode.
The following command assigns a service policy named serv_policy3 to this service:
Proxy-CSCF Configuration Mode commands are defined in the CSCF Proxy-CSCF Configuration Mode Commands chapter in this guide.
Important: The Proxy-CSCF is a license-enabled function of the Session Control Manager. Only one function (P-CSCF, S-CSCF, E-CSCF, SIP Proxy, or A-BG) can be enabled per service.timeout seconds
seconds must be an integer from 5 to 3600.
SIP Proxy Configuration Mode commands are defined in the CSCF SIP Proxy Configuration Mode Commands chapter in this guide.
Important: The SIP Proxy is a license-enabled function of the Session Control Manager. Only one function (P-CSCF, S-CSCF, E-CSCF, SIP Proxy, or A-BG) can be enabled per service.Serving-CSCF Configuration Mode commands are defined in the CSCF Serving-CSCF Configuration Mode Commands chapter in this guide.
Important: The Serving-CSCF is a license-enabled function of the Session Control Manager. Only one function (P-CSCF, S-CSCF, E-CSCF, SIP Proxy, or A-BG) can be enabled per service.[ no ] serving-cscf-list server { address address | domain domain } { capability value | port num { capability value } }
address address: IP addresses must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
domain domain: Domain names must be entered using from 1 to 80 alpha and/or numeric characters.
capability value
Specifies the capability of the S-CSCF server. value is assigned by the Service Provider and may be an integer from 1 to 999999.
port num
Specifies the port at which service is provided by the S-CSCF server. num may be an integer from 1 to 65535.
Important: This command can be entered multiple times to identify multiple Serving CSCFs.The following command adds a S-CSCF with an IP address of 1.2.3.4 and a capability value of 75 to this service’s list:
min-se sec
sec must be an integer value between 90 and the value of the session-expires command.
session-expires sec
sec must be an integer value between 90 and 18000.
subscription package reg [ lifetime { default sec | max sec [ default sec ] | min sec [ max sec ] [ default sec ] } ]
default sec: Specifies the default amount of time that a subscription can exist on the system. sec must be an integer from 60 to max sec -1.
Important: default sec must be < or = to max sec and > or = to min sec.max sec: Specifies the maximum amount of time that a subscription can exist on the system.
sec must be an integer from 60 to 2147483646.
Important: max sec must be > or = to min sec.min sec: Specifies the minimum amount of time that a subscription can exist on the system.
sec must be an integer from 60 to max sec -1.
Important: min sec must be < or = to max sec.The following command configures the maximum subscription lifetime to 43200 (12 hours):
port port_number
port_number must be an integer from 1 to 65534.
threshold { { call-setup-failures | call-total-active | error-no-resource | error-presence | error-reg-auth | error-tcp | invite-rcvd-rate | monitoring | reg-rcvd-rate | reg-total-active | route-failures } high_thresh [ clear low_thresh ] | monitoring }
{ call-setup-failures | call-total-active | error-no-resource | error-presence | error-reg-auth | error-tcp | invite-rcvd-rate | reg-rcvd-rate | reg-total-active | route-failures } high_thresh clear low_thresh
call-setup-failures: Number of CSCF call setup failures.
call-total-active: Number of total active CSCF calls.
error-no-resource: Number of CSCF call setup failures due to no-resource.
error-presence: Number of CSCF Presence errors.
error-reg-auth: Number of CSCF Registration Authentication failures.
error-tcp: Number of CSCF call setup failures due to TCP error.
invite-rcvd-rate: Number of CSCF calls per polling interval.
reg-rcvd-rate: Number of CSCF registrations per polling interval.
reg-total-active: Number of total CSCF active registrations.
route-failures: Maximum number of route-failures, after which the alarm/alert will be raised. Default: 5
high_thresh: The high threshold number that must be met or exceeded within the polling interval to generate an alert or alarm. Can be configured to any integer value between 0 and 2000000 (0 and 60000 for route-failures).
clear low_thresh: The low threshold number that must be met or exceeded within the polling interval to clear an alert or alarm. Can be configured to any integer value between 0 and 2000000 (0 and 60000 for route-failures).
Important: This value is ignored for the Alert model. In addition, if this value is not configured for the Alarm model, the system assumes it is identical to the high threshold.The following command configures a route failures threshold of 1000 and a low threshold of 500 for a system using the Alarm thresholding model:
timeout { hss-wait sec | map-slr-response sec | no-answer sec | policy-interface sec | sip { 3gpp-d sec | 3gpp-t1 msec | 3gpp-t2 sec | 3gpp-t4 sec | c sec | d sec | idle-tcp-connection msec [ cleanup-timer msec ] | invite-expiry sec | t1 msec | t2 sec | t4 sec } }
hss-wait sec
sec must be an integer from 0 to 2147483646.
map-slr-response sec
sec must be an integer from 15 to 30.
no-answer sec
sec must be an integer from 0 to 2147483646.
policy-interface sec
sec must be an integer from 0 to 2147483646.
sip { 3gpp-d sec | 3gpp-t1 msec | 3gpp-t2 sec | 3gpp-t4 sec | c sec | d sec | idle-tcp-connection msec [ cleanup-timer msec ] | invite-expiry sec | t1 msec | t2 sec | t4 sec }
|
•
|
3gpp-d sec: This timer is used to control the retransmission of 200OK messages to INVITEs after an ACK is sent. The ACK transaction is cleared after this period. This timer is applicable only for unreliable transport. sec must be an integer from 0 to 2147483646.
|
|
•
|
3gpp-t1 msec: This timer is used to control the time interval between each retransmission. The interval doubles after each retransmission. This is used by P-CSCF/A-BG only when it sending message toward the UE. Example: T1, 2T1, 4T2, etc. This timer is applicable only for unreliable transport. msec must be an integer from 0 to 4294967294.
|
|
•
|
3gpp-t2 sec: This timer is used to control the period for which the request continues to get retransmitted. This is used by P-CSCF/A-BG only when it sending message toward the UE. This timer is applicable both for reliable and unreliable transport. sec must be an integer from 0 to 2147483646.
|
|
•
|
3gpp-t4 sec: This timer is used to control the period for which the final response to non-invite transaction should be buffered. The buffered response for the retransmitted non-invite request should be sent within that interval. This timer is applicable only for unreliable transport. sec must be an integer from 0 to 2147483646.
|
|
•
|
c sec: This timer is used for an INVITE transaction; if the response is a provisional response with status codes 101 to 199 inclusive (anything but 100), the proxy must reset timer C for that client transaction. The timer may be reset to a different value, but this value must be greater than 3 minutes (180 seconds). When timer C in S-CSCF fires first, S-CSCF will send CANCEL request to Terminating P-CSCF and Terminating P-CSCF will send CANCEL request to UAS . sec must be an integer from 180 to 2147483646.
|
|
•
|
d sec: This timer is used to control the retransmission of 200OK to INVITE after ACK is sent. The ACK transaction will be cleared after this interval. This timer is applicable only for unreliable transport. sec must be an integer from 0 to 2147483646.
|
|
•
|
idle-tcp-connection msec: This timer is used for closing idle TCP connections. If there is not activity in the TCP connection for the configuration duration, then the connection will be closed. msec must be an integer from 1000 (recommended minimum) to 4294967294.
|
|
•
|
cleanup-timer msec: This timer is used to control how often to check for idle TCP connections. msec must be an integer from 2000 to 2147483646.
|
|
•
|
invite-expiry sec: This timer is used by SIP while acting as UA Role and no final response is received for the INVITE request sent. This timer is applicable for both reliable and unreliable transport. sec must be an integer from 0 to 2147483646.
|
|
•
|
t1 msec: Specifies the time interval (in microseconds) between each retransmission. The interval doubles after each retransmission, for example: T1, 2T1, 4T2, etc. This timer is applicable only for unreliable transport. msec must be an integer from 0 to 2147483646.
|
|
•
|
t2 sec: This timer is used to control the period for which the request keeps getting retransmitted. This timer is applicable both for reliable and unreliable transport. sec must be an integer from 0 to 2147483646. The recommended minimum value for this parameter is 4 seconds.
|
|
•
|
t4 sec: This timer is used to control the period for which the final response to non-invite transaction should be buffered so as to send the buffered response for the retransmitted non-invite request within that interval. This timer is applicable only for unreliable transport. sec must be an integer from 0 to 2147483646.
|
The following command sets the SIP d timer to 64 seconds:
size can be configured to any integer value between 1300 and 65535.
Switch to TCP transport protocol when the SIP message size is 4000 bytes or more:
no trusted-domain-entity address
trusted-domain-entity address
Specifies the IP address of the network node identified as a trusted entity by this service. address must be either an IP address or a domain name. IP addresses must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6. Domain names must be entered using from 1 to 80 alpha and/or numeric characters.
Important: This command can be entered multiple times to identify multiple trusted network entities.The following command adds a network node with an IP address of 1.2.3.4 to this service’s trusted domain table:
